Show:

ia.Report Class

Extends ia.EventDispatcher
Defined in: ia\Report.js:1
Module: ia

Used to build and manage widgets.

Constructor

ia.Report

(
  • reportContainer
)

Defined in ia\Report.js:1

Parameters:

  • reportContainer JQUERY Element

    The report container.

Methods

addButton

(
  • btn
)

Defined in ia\Report.js:346

Adds a new button.

Parameters:

addCallout

(
  • callout
)

Defined in ia\Report.js:218

Adds a callout.

Parameters:

addComponent

(
  • id
  • component
)

Defined in ia\Report.js:188

Adds a component.

Parameters:

  • id String

    The component id.

  • component Object

    The component to add.

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

addImage

(
  • img
)

Defined in ia\Report.js:406

Adds a new image.

Parameters:

addPanel

(
  • panel
)

Defined in ia\Report.js:312

Adds a new panel.

Parameters:

addText

(
  • txt
)

Defined in ia\Report.js:376

Adds new text.

Parameters:

addWidget

(
  • widget
)

Defined in ia\Report.js:248

Adds a new widget.

Parameters:

build

(
  • callbackFnc
)

Defined in ia\Report.js:436

Builds a set of widgets based on the passed config object.

Parameters:

  • callbackFnc Function

    Function called when build is complete.

closePopups

(
  • id
)

Defined in ia\Report.js:683

Closes all popup windows except the one with the passed id.

Parameters:

  • id String

    The popup id that should not be closed.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

displayEvaluationMessage

(
  • panel
)
private

Defined in ia\Report.js:610

Displays the evaluation message.

Parameters:

  • panel ia.Panel

    The panel to hold the message.

endProgress

(
  • id
)

Defined in ia\Report.js:556

Ends the progress bar.

Parameters:

  • id String

    The id of the progress bar.

endProgress

(
  • id
)

Defined in ia\Report.js:593

Allows report interaction.

Parameters:

  • id String

    The id of the interaction blocker.

getButton

(
  • id
)
ia.Button

Defined in ia\Report.js:367

Returns the component that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.Button: The button.

getButtons

() ia.Button[]

Defined in ia\Report.js:359

Returns the buttons.

Returns:

ia.Button[]: An array of buttons.

getCallout

(
  • id
)
ia.CalloutBox

Defined in ia\Report.js:239

Returns the callout that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.CalloutBox: The callout.

getCallouts

() ia.CalloutBox[]

Defined in ia\Report.js:231

Returns all callouts.

Returns:

ia.CalloutBox[]: An array of callouts.

getComponent

(
  • id
)
Object

Defined in ia\Report.js:209

Returns the component that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

Object: The component.

getComponents

() Object

Defined in ia\Report.js:201

Returns all components.

Returns:

Object: An array of components.

getImage

(
  • id
)
ia.Image

Defined in ia\Report.js:427

Returns the image that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.Image: The image.

getImages

() ia.Image[]

Defined in ia\Report.js:419

Returns the images.

Returns:

ia.Image[]: An array of images.

getPanel

(
  • id
)
ia.Panel

Defined in ia\Report.js:333

Returns the panel that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.Panel: The panel.

getPanels

() ia.Panel[]

Defined in ia\Report.js:325

Returns the panels.

Returns:

ia.Panel[]: An array of panels.

getText

(
  • id
)
ia.Text

Defined in ia\Report.js:397

Returns the text that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.Text: The text.

getTexts

() ia.Text[]

Defined in ia\Report.js:389

Returns the text.

Returns:

ia.Text[]: An array of text.

getWidget

(
  • id
)
ia.Widget

Defined in ia\Report.js:269

Returns the widget that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.Widget: The widget.

getWidgets

() ia.Widget[]

Defined in ia\Report.js:261

Returns all widgets.

Returns:

ia.Widget[]: An array of widgets.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

removeWidgets

()

Defined in ia\Report.js:282

Removes all widgets.

startProgress

(
  • id
  • showWaitCursor
  • callbackFnc
)

Defined in ia\Report.js:573

Bloacks report interaction.

Parameters:

  • id String

    The id of the interaction blocker.

  • showWaitCursor Boolean

    Should wait cursor be displayed.

  • callbackFnc Function

    The callbackFnc gets called once the progress container is ready.

startProgress

(
  • id
  • callbackFnc
)

Defined in ia\Report.js:537

Starts the progress bar.

Parameters:

  • id String

    The id of the progress bar.

  • callbackFnc Function

    The callbackFnc gets called once the progress container is ready.

updateDynamicText

(
  • textSubstitution
)

Defined in ia\Report.js:508

Updates dynamic text of widgets.

Parameters:

Properties

config

ia.ReportConfig

Defined in ia\Report.js:72

The report config object.

container

JQUERY Element

Defined in ia\Report.js:64

The container that holds the object.

data

ia.ReportData

Defined in ia\Report.js:88

The report data object.

evaluation

Boolean

Defined in ia\Report.js:163

Is it an evaluation version.

Default: true

highlightColor

String

Defined in ia\Report.js:128

The report highlight color.

highlightOpacity

Number

Defined in ia\Report.js:145

The report highlight opacity.

Default: 0.3

locale

ia.Locale

Defined in ia\Report.js:96

The report locale object.

selectionColor

String

Defined in ia\Report.js:120

The report selection color.

selectionOpacity

Number

Defined in ia\Report.js:136

The report selection opacity.

Default: 0.3

template

String

Defined in ia\Report.js:172

The template number.

textSubstitution

ia.TextSubstitution

Defined in ia\Report.js:104

The report text substitution object.

uid

String

Defined in ia\Report.js:154

Unique id.

Default: ""

url

ia.UrlParams

Defined in ia\Report.js:112

The report url object.

version

String

Defined in ia\Report.js:180

The version number.

webMapData

ia.WebMapData

Defined in ia\Report.js:80

An ArcGIS Web Map object.